Skip to content

WIP Lucene documentation updates#1216

Open
duncdrum wants to merge 3 commits intoeXist-db:masterfrom
duncdrum:docs-lucene-upgrade
Open

WIP Lucene documentation updates#1216
duncdrum wants to merge 3 commits intoeXist-db:masterfrom
duncdrum:docs-lucene-upgrade

Conversation

@duncdrum
Copy link
Contributor

@duncdrum duncdrum commented Mar 17, 2026

Very much targeting 7.0.0

TODO

  • review pre-existing examples for outdated syntax and analysers

see eXist-db/exist#6146

@duncdrum duncdrum added this to v7.0.0 Mar 17, 2026
- Updated .gitignore to correct the entry for hs_err_pid.
- Added "version": "6.1.3-SNAPSHOT" to package-lock.json and package.json for consistency.

chore: refactor Gulpfile and update dependencies for improved build process

- Removed unused script-related settings and tasks from Gulpfile.js.
- Updated Gulp tasks to use async/await for better handling of asynchronous operations.
- Replaced deprecated gulp plugins with modern alternatives (e.g., gulp-postcss, autoprefixer, cssnano).
- Enhanced SVG optimization process using svgo with dynamic import.
- Updated package.json and package-lock.json to reflect new versions and dependencies.
- Bumped project version to 7.0.0-SNAPSHOT in package files and pom.xml.
- Updated Lucene version references in documentation from 4.10.4 to 10.3.0.
- Introduced new vector field configuration in `listing-90.xml` for KNN and semantic search.
- Added example queries for vector fields in `listing-91.txt`.
- Included reindexing commands for vector fields in `listing-92.txt`.
- Minor formatting adjustments in existing XML listings.
…registry examples

- Added details about on-disk structures related to Lucene vector indexing in backup and configuration documentation.
- Introduced a new section for vector model registry in configuration, including examples for registering embedding models.
- Updated indexing documentation to clarify additional files created by vector indexing.
- Added two new XML listings demonstrating model registration and configuration.
@duncdrum duncdrum force-pushed the docs-lucene-upgrade branch from 48c41de to f3b30c7 Compare March 25, 2026 12:07
@duncdrum duncdrum marked this pull request as ready for review March 25, 2026 14:03
Copy link
Member

@line-o line-o left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for providing the documentation for this large change. That definitely helped me to get up to speed.

I would love to see this PR split up into a) a PR that updates the build and b) the Lucene Vector documentation. I offer my help to achieve that.

For the documentation itself, I find it comprehensive and covering the important settings. I think it would help to explain that the docbook articles of the documentation can be used.
The examples would have to be slightly adapted to include the docbook namespace but it makes it a whole lot easier to come to a local working example.

The question I have on the configuration is actually something to discuss in the implementation PR. It is just that I saw it here first.

@duncdrum
Copy link
Contributor Author

Since the PR combines the two, I think it ll make our live easier to keep it that way here too. It already allows me to have up to date docs with the test containers, if we split this I wouldn't be able to do that. Also the inevitable rebases until we an merge will be easier to handle if we have just one branch / PR to keep in sync.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants